Microsoft Cognitive Language Service - Question Answering Authoring (preview:2025-05-15)

2025/09/22 • 1 updated methods

QuestionAnsweringProjects_Import (updated)
Description :  Import project assets.
Reference :  Link ¶

⚶ Changes

{
  "#id": "QuestionAnsweringProjects_Import",
  "$parameters": {
    "body": {
      "Description": {
        "new": "Project assets that need to be imported.",
        "old": "Project assets the needs to be imported."
      }
    }
  }
}

⚼ Request

POST:  /authoring/query-knowledgebases/projects/{projectName}/:import
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
format:
{
Description: Knowledge base Import or Export format. ,
Required: False ,
}
string ,
assetKind:
{
Description: Kind of the asset of the project. ,
Required: False ,
}
string ,
body:
{
Description: Project assets the needs to be imported. ,
Required: False ,
}
{
metadata:
{
Description: Parameters needed to create the project. ,
Required: False ,
}
{
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
description:
{
Description: Description of the project. ,
Required: False ,
}
string ,
language:
{
Description: Language of the text records. This is BCP-47 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default. ,
Required: False ,
}
string ,
multilingualResource:
{
Description: Resource enabled for multiple languages across projects or not. ,
Required: False ,
}
boolean ,
settings:
{
Description: Configurable settings of the Project. ,
Required: False ,
}
{
defaultAnswer:
{
Description: Default Answer response when no good match is found in the knowledge base. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Project creation date-time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modified date-time. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment date-time. ,
Format: date-time ,
Required: False ,
}
string ,
configureSemanticRanking:
{
Description: Represents if semantic ranking is configured. ,
Required: False ,
}
boolean ,
}
,
assets:
{
Description: All assets for this project. ,
Required: False ,
}
{
synonyms:
{
Description: Collection of synonyms. ,
Required: False ,
}
[
{
alterations:
{
Description: Collection of word alterations. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
qnas:
{
Description: List of QnA records to import. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID for the QnA. ,
Format: int32 ,
Required: True ,
}
integer ,
answer:
{
Description: Answer text. ,
Required: False ,
}
string ,
source:
{
Description: Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs . ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: Metadata associated with the answer, useful to categorize or filter question answers. ,
Required: False ,
}
object ,
dialog:
{
Description: Context of a QnA. ,
Required: False ,
}
{
isContextOnly:
{
Description: To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as answer for queries without context; otherwise, ignores context and includes this QnA in answers. ,
Required: False ,
}
boolean ,
prompts:
{
Description: List of prompts associated with the answer. ,
Required: False ,
}
[
{
displayOrder:
{
Description: Index of the prompt. It is used for ordering of the prompts. ,
Format: int32 ,
Required: False ,
}
integer ,
qnaId:
{
Description: ID of the QnA corresponding to the prompt. ,
Format: int32 ,
Required: False ,
}
integer ,
qna:
{
Description: QnA record. Either QnAId or QnA record needs to be present in a Prompt. ,
Required: False ,
}
{
id:
{
Description: Unique ID for the QnA. ,
Format: int32 ,
Required: True ,
}
integer ,
answer:
{
Description: Answer text. ,
Required: False ,
}
string ,
source:
{
Description: Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs . ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: Metadata associated with the answer, useful to categorize or filter question answers. ,
Required: False ,
}
object ,
dialog:
{
Required: False ,
}
string ,
activeLearningSuggestions:
{
Description: List of Active Learning suggestions for the QnA. ,
Required: False ,
}
[
{
clusterHead:
{
Description: Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm. ,
Required: False ,
}
string ,
suggestedQuestions:
{
Description: List of all suggested questions for the QnA. ,
Required: False ,
}
[
{
question:
{
Description: Question suggested by the Active Learning feature. ,
Required: False ,
}
string ,
userSuggestedCount:
{
Description: The number of times the question was suggested explicitly by the user. ,
Format: int32 ,
Required: False ,
}
integer ,
autoSuggestedCount:
{
Description: The number of times the question was suggested automatically by the Active Learning algorithm. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
displayText:
{
Description: Text displayed to represent a follow up question prompt. ,
Required: False ,
}
string ,
}
,
]
,
}
,
activeLearningSuggestions:
{
Description: List of Active Learning suggestions for the QnA. ,
Required: False ,
}
[
{
clusterHead:
{
Description: Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm. ,
Required: False ,
}
string ,
suggestedQuestions:
{
Description: List of all suggested questions for the QnA. ,
Required: False ,
}
[
{
question:
{
Description: Question suggested by the Active Learning feature. ,
Required: False ,
}
string ,
userSuggestedCount:
{
Description: The number of times the question was suggested explicitly by the user. ,
Format: int32 ,
Required: False ,
}
integer ,
autoSuggestedCount:
{
Description: The number of times the question was suggested automatically by the Active Learning algorithm. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
lastUpdatedDateTime:
{
Description: Date-time when the QnA was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDisplayName:
{
Description: Friendly name of the Source. ,
Required: False ,
}
string ,
}
,
]
,
}
,
fileUri:
{
Description: Import data File URI. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}